Implement basic categorization for libraries in dartdoc #1641
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jcollins-g
force-pushed
the
dartdoc-categories
branch
from
0129842 to
7423e0e
Compare
kevmoo
approved these changes
Mar 23, 2018
scheglov
approved these changes
Mar 23, 2018
kevmoo
reviewed
Mar 23, 2018
| generates docs. | ||
|
|
||
| ```yaml | ||
| dartdoc: |
There was a problem hiding this comment.
Why have a dartdoc top key in dartdoc_options.yaml?
Couldn't categoryOrder just be at the top?
There was a problem hiding this comment.
This was paralleling with analysis_options.yaml, which has analyzer and linter subsections. There might be an opportunity for sections for other tools using dartdoc libraries, such as the still vaporware API comparison gadget.
kevmoo
reviewed
Mar 23, 2018
README.md
Outdated
| @@ -114,6 +142,9 @@ and then you can insert it via `{@macro template_name}`, like | |||
| /// More comments | |||
| ``` | |||
|
|
|||
|
|
|||
jcollins-g
commented
Mar 23, 2018
README.md
Outdated
| @@ -114,6 +142,9 @@ and then you can insert it via `{@macro template_name}`, like | |||
| /// More comments | |||
| ``` | |||
|
|
|||
|
|
|||
| generates docs. | ||
|
|
||
| ```yaml | ||
| dartdoc: |
There was a problem hiding this comment.
This was paralleling with analysis_options.yaml, which has analyzer and linter subsections. There might be an opportunity for sections for other tools using dartdoc libraries, such as the still vaporware API comparison gadget.
|
ack
…On Fri, Mar 23, 2018 at 11:42 AM jcollins-g ***@***.***> wrote:
***@***.**** commented on this pull request.
Document my new feature? In our moment of triumph?
------------------------------
In README.md
<#1641 (comment)>:
> @@ -114,6 +142,9 @@ and then you can insert it via ***@***.*** template_name}`, like
/// More comments
```
+
done.
------------------------------
In README.md
<#1641 (comment)>:
> @@ -95,6 +95,34 @@ authoring doc comments for Dart with `dartdoc`.
## Advanced features
+### dartdoc_options.yaml
+
+Creating a file named dartdoc_options.yaml at the top of your package can change how Dartdoc
+generates docs.
+
+```yaml
+dartdoc:
This was paralleling with analysis_options.yaml, which has analyzer and
linter subsections. There might be an opportunity for sections for other
tools using dartdoc libraries, such as the still vaporware API comparison
gadget.
—
You are receiving this because your review was requested.
Reply to this email directly, view it on GitHub
<#1641 (review)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AABCir1ZQEaYcyu1b_DA6p4fQk3zr3_6ks5thUIGgaJpZM4S3vNP>
.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1610.
Also, this is the beginning of a longer chain to implement #1353.
This allows you to mark libraries with
{@category Foo}and have libraries appear in a category in the sidebar and in the main package view. Uncategorized libraries appear at the top. An example:https://user-images.githubusercontent.com/14116827/37685847-3f34c478-2c52-11e8-82b9-6b1485a5a05d.png
This PR also eliminates the "use-categories" flag. The "old style" meaning of categories meaning packages is now gone. The flag is now ignored and Dartdoc decides whether to organize libraries into packages based on whether there are multiple packages in the requested set of libraries.